/**
 * Copyright 2010 Tristan Slominski
 *
 * Licensed under the MIT License (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.opensource.org/licenses/mit-license.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mindash.handlebars.client.pages.utils;

import com.google.gwt.user.client.Timer;
import com.mindash.handlebars.client.places.GoToPlace;

/**
 * @author Tristan Slominski
 *
 */
public interface Redirect {

  /**
   * Redirects to the indicated {@code goTo} place after indicated {@code
   * secondsDelay}.
   * 
   * @param goTo the place to go to
   * @param secondsDelay the delay in seconds
   * @return a {@code Timer} object, it is not necessary to store or do anything
   * with it
   */
  public Timer doRedirect(GoToPlace<?> goTo, int secondsDelay);
  
}
